Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(events): add description property for eventBus #30935

Merged
merged 6 commits into from
Jul 31, 2024
Merged

feat(events): add description property for eventBus #30935

merged 6 commits into from
Jul 31, 2024

Conversation

yuppe-kyupeen
Copy link
Contributor

@yuppe-kyupeen yuppe-kyupeen commented Jul 24, 2024 •
edited
Loading

Issue # (if applicable)

N/A

Reason for this change

The change introduces the description property to the EventBus

Description of changes

  • Add the description property for EventBusProps, which was missing in the L2 construct.
  • Add validation for character limit

Description of how you validated changes

I Added a unit test for eventBus and added the description property in the integration tests.

Checklist

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@github-actions github-actions bot added beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK p2 labels Jul 24, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team July 24, 2024 03:33
@github-actions GitHub Actions
Copy link

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

@yuppe-kyupeen yuppe-kyupeen reopened this Jul 24, 2024
@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jul 24, 2024
go-to-k
go-to-k suggested changes Jul 24, 2024
View reviewed changes
Copy link
Contributor

@go-to-k go-to-k left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, but I just made a few comments.

packages/aws-cdk-lib/aws-events/test/event-bus.test.ts Outdated
@@ -40,11 +40,13 @@ describe('event bus', () => {
// WHEN
new EventBus(stack, 'Bus', {
eventBusName: 'myEventBus',
description: 'myEventBus',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you separate it and create a new test because the name of this test is 'named event bus'?

packages/aws-cdk-lib/aws-events/test/event-bus.test.ts Outdated
@@ -281,6 +283,19 @@ describe('event bus', () => {
}).toThrow(/'eventSourceName' must satisfy: /);
});

test('throw error when description is too long', () => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Usually this test name is fine, but in this file, many tests for other errors have names of the following form: 'event bus xx cannot ...', so could you please match them?

@aws-cdk-automation aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jul 24, 2024
@yuppe-kyupeen
Copy link
Contributor Author

@go-to-k
Thanks for always reviewing!
I've made the changes. Please check🙏

go-to-k
go-to-k approved these changes Jul 25, 2024
View reviewed changes
Copy link
Contributor

@go-to-k go-to-k left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jul 25, 2024
@github-actions github-actions bot mentioned this pull request Jul 29, 2024
Closed
@Leo10Gama Leo10Gama self-assigned this Jul 29, 2024
Leo10Gama
Leo10Gama previously requested changes Jul 29, 2024
View reviewed changes
Copy link
Member

@Leo10Gama Leo10Gama left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR! Just left one comment regarding the token check.

packages/aws-cdk-lib/aws-events/lib/event-bus.ts Show resolved Hide resolved
@aws-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jul 29, 2024
Leo10Gama
Leo10Gama reviewed Jul 31, 2024
View reviewed changes
Copy link
Member

@Leo10Gama Leo10Gama left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Giving it a second look-over, everything seems fine! Just one minor nit about the phrasing of the docstring.

packages/aws-cdk-lib/aws-events/lib/event-bus.ts Outdated Show resolved Hide resolved
@TheRealAmazonKendra @Leo10Gama
Update packages/aws-cdk-lib/aws-events/lib/event-bus.ts
da57c04 
Co-authored-by: Leonardo Gama <51037424+Leo10Gama@users.noreply.github.com>
@mergify mergify bot dismissed Leo10Gama’s stale review July 31, 2024 17:43

Pull request has been modified.

TheRealAmazonKendra
TheRealAmazonKendra reviewed Jul 31, 2024
View reviewed changes
Copy link
Contributor

@TheRealAmazonKendra TheRealAmazonKendra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Committing the suggested change to the wording and approving per @Leo10Gama's review.

Leo10Gama
Leo10Gama previously approved these changes Jul 31, 2024
View reviewed changes
@mergify Mergify
Copy link
Contributor

mergify bot commented Jul 31, 2024

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot dismissed Leo10Gama’s stale review July 31, 2024 20:17

Pull request has been modified.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 7c418a9
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jul 31, 2024
@mergify Mergify
Copy link
Contributor

mergify bot commented Jul 31, 2024

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot merged commit 28fbc82 into aws:main Jul 31, 2024
14 checks passed
@github-actions GitHub Actions
Copy link

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 31, 2024
@aws-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jul 31, 2024
@yuppe-kyupeen yuppe-kyupeen deleted the add-description-for-eventBus branch July 31, 2024 22:47
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@go-to-k go-to-k go-to-k approved these changes

@TheRealAmazonKendra TheRealAmazonKendra TheRealAmazonKendra left review comments

@Leo10Gama Leo10Gama Leo10Gama approved these changes

Assignees

@Leo10Gama Leo10Gama

Labels
beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK p2
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@yuppe-kyupeen @aws-cdk-automation @go-to-k @Leo10Gama @TheRealAmazonKendra